Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

revert change to shared UX markdown component for dashboard vis #180906

Merged

Conversation

eokoneyo
Copy link
Contributor

@eokoneyo eokoneyo commented Apr 16, 2024

Summary

This PR reverts the change to the shared UX markdown component that happened here #176478. The aforementioned PR introduced couple of visual issues that were uncaught during the migration.

The known issues that have been brought up that informed the decision to revert this change, are itemised below;

Checklist

For maintainers

@eokoneyo eokoneyo added Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience) backport:all-open Backport to all branches that could still receive a release v8.14.0 labels Apr 16, 2024
@eokoneyo eokoneyo self-assigned this Apr 16, 2024
@eokoneyo
Copy link
Contributor Author

/ci

1 similar comment
@eokoneyo
Copy link
Contributor Author

/ci

@eokoneyo eokoneyo force-pushed the patch/revert-markdown-changes-for-dashboard-vis branch from 4c6e0a7 to 632095c Compare April 16, 2024 15:33
@eokoneyo
Copy link
Contributor Author

/ci

@eokoneyo
Copy link
Contributor Author

/ci

@eokoneyo eokoneyo marked this pull request as ready for review April 16, 2024 20:55
@eokoneyo eokoneyo requested review from a team as code owners April 16, 2024 20:55
@elasticmachine
Copy link
Contributor

Pinging @elastic/appex-sharedux (Team:SharedUX)

@eokoneyo
Copy link
Contributor Author

@elasticmachine merge upstream

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
visTypeMarkdown 21 19 -2

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
visTypeMarkdown 7.0KB 5.8KB -1.1KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
visTypeMarkdown 6.9KB 7.0KB +141.0B

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @eokoneyo

@eokoneyo eokoneyo merged commit 4127163 into elastic:main Apr 18, 2024
16 checks passed
@eokoneyo eokoneyo deleted the patch/revert-markdown-changes-for-dashboard-vis branch April 18, 2024 12:01
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Apr 18, 2024
…tic#180906)

## Summary

This PR reverts the change to the shared UX markdown component that
happened here elastic#176478. The
aforementioned PR introduced couple of visual issues that were uncaught
during the migration.

The known issues that have been brought up that informed the decision to
revert this change, are itemised below;

- elastic#180576
- elastic#180452
- elastic/sdh-kibana#4608

### Checklist

- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios

### For maintainers

- [x] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

---------

Co-authored-by: kibanamachine <[email protected]>
(cherry picked from commit 4127163)
@kibanamachine
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
7.17 Backport failed because of merge conflicts
8.14

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

node scripts/backport --pr 180906

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Apr 18, 2024
#180906) (#181140)

# Backport

This will backport the following commits from `main` to `8.14`:
- [revert change to shared UX markdown component for dashboard vis
(#180906)](#180906)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Eyo O.
Eyo","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-04-18T12:01:18Z","message":"revert
change to shared UX markdown component for dashboard vis (#180906)\n\n##
Summary\r\n\r\nThis PR reverts the change to the shared UX markdown
component that\r\nhappened here
#176478. The\r\naforementioned PR
introduced couple of visual issues that were uncaught\r\nduring the
migration.\r\n\r\nThe known issues that have been brought up that
informed the decision to\r\nrevert this change, are itemised
below;\r\n\r\n- https://github.com/elastic/kibana/issues/180576\r\n-
https://github.com/elastic/kibana/issues/180452\r\n-
https://github.com/elastic/sdh-kibana/issues/4608\r\n\r\n\r\n###
Checklist\r\n\r\n- [x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n\r\n\r\n### For
maintainers\r\n\r\n- [x] This was checked for breaking API changes and
was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"4127163bd913dccfbd17badbb9ce1a7a5b2afadc","branchLabelMapping":{"^v8.15.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:fix","Team:SharedUX","backport:all-open","v8.14.0","v8.15.0"],"title":"revert
change to shared UX markdown component for dashboard
vis","number":180906,"url":"https://github.com/elastic/kibana/pull/180906","mergeCommit":{"message":"revert
change to shared UX markdown component for dashboard vis (#180906)\n\n##
Summary\r\n\r\nThis PR reverts the change to the shared UX markdown
component that\r\nhappened here
#176478. The\r\naforementioned PR
introduced couple of visual issues that were uncaught\r\nduring the
migration.\r\n\r\nThe known issues that have been brought up that
informed the decision to\r\nrevert this change, are itemised
below;\r\n\r\n- https://github.com/elastic/kibana/issues/180576\r\n-
https://github.com/elastic/kibana/issues/180452\r\n-
https://github.com/elastic/sdh-kibana/issues/4608\r\n\r\n\r\n###
Checklist\r\n\r\n- [x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n\r\n\r\n### For
maintainers\r\n\r\n- [x] This was checked for breaking API changes and
was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"4127163bd913dccfbd17badbb9ce1a7a5b2afadc"}},"sourceBranch":"main","suggestedTargetBranches":["8.14"],"targetPullRequestStates":[{"branch":"8.14","label":"v8.14.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.15.0","branchLabelMappingKey":"^v8.15.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/180906","number":180906,"mergeCommit":{"message":"revert
change to shared UX markdown component for dashboard vis (#180906)\n\n##
Summary\r\n\r\nThis PR reverts the change to the shared UX markdown
component that\r\nhappened here
#176478. The\r\naforementioned PR
introduced couple of visual issues that were uncaught\r\nduring the
migration.\r\n\r\nThe known issues that have been brought up that
informed the decision to\r\nrevert this change, are itemised
below;\r\n\r\n- https://github.com/elastic/kibana/issues/180576\r\n-
https://github.com/elastic/kibana/issues/180452\r\n-
https://github.com/elastic/sdh-kibana/issues/4608\r\n\r\n\r\n###
Checklist\r\n\r\n- [x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n\r\n\r\n### For
maintainers\r\n\r\n- [x] This was checked for breaking API changes and
was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"4127163bd913dccfbd17badbb9ce1a7a5b2afadc"}}]}]
BACKPORT-->

Co-authored-by: Eyo O. Eyo <[email protected]>
@eokoneyo
Copy link
Contributor Author

💚 All backports created successfully

Status Branch Result
8.13

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

eokoneyo added a commit to eokoneyo/kibana that referenced this pull request Apr 24, 2024
…tic#180906)

## Summary

This PR reverts the change to the shared UX markdown component that
happened here elastic#176478. The
aforementioned PR introduced couple of visual issues that were uncaught
during the migration.

The known issues that have been brought up that informed the decision to
revert this change, are itemised below;

- elastic#180576
- elastic#180452
- elastic/sdh-kibana#4608

### Checklist

- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios

### For maintainers

- [x] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

---------

Co-authored-by: kibanamachine <[email protected]>
(cherry picked from commit 4127163)
eokoneyo added a commit that referenced this pull request Apr 24, 2024
#180906) (#181517)

# Backport

This will backport the following commits from `main` to `8.13`:
- [revert change to shared UX markdown component for dashboard vis
(#180906)](#180906)

<!--- Backport version: 8.9.8 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Eyo O.
Eyo","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-04-18T12:01:18Z","message":"revert
change to shared UX markdown component for dashboard vis (#180906)\n\n##
Summary\r\n\r\nThis PR reverts the change to the shared UX markdown
component that\r\nhappened here
#176478. The\r\naforementioned PR
introduced couple of visual issues that were uncaught\r\nduring the
migration.\r\n\r\nThe known issues that have been brought up that
informed the decision to\r\nrevert this change, are itemised
below;\r\n\r\n- https://github.com/elastic/kibana/issues/180576\r\n-
https://github.com/elastic/kibana/issues/180452\r\n-
https://github.com/elastic/sdh-kibana/issues/4608\r\n\r\n\r\n###
Checklist\r\n\r\n- [x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n\r\n\r\n### For
maintainers\r\n\r\n- [x] This was checked for breaking API changes and
was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"4127163bd913dccfbd17badbb9ce1a7a5b2afadc","branchLabelMapping":{"^v8.15.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:fix","Team:SharedUX","backport:all-open","v8.14.0","v8.15.0"],"number":180906,"url":"https://github.com/elastic/kibana/pull/180906","mergeCommit":{"message":"revert
change to shared UX markdown component for dashboard vis (#180906)\n\n##
Summary\r\n\r\nThis PR reverts the change to the shared UX markdown
component that\r\nhappened here
#176478. The\r\naforementioned PR
introduced couple of visual issues that were uncaught\r\nduring the
migration.\r\n\r\nThe known issues that have been brought up that
informed the decision to\r\nrevert this change, are itemised
below;\r\n\r\n- https://github.com/elastic/kibana/issues/180576\r\n-
https://github.com/elastic/kibana/issues/180452\r\n-
https://github.com/elastic/sdh-kibana/issues/4608\r\n\r\n\r\n###
Checklist\r\n\r\n- [x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n\r\n\r\n### For
maintainers\r\n\r\n- [x] This was checked for breaking API changes and
was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"4127163bd913dccfbd17badbb9ce1a7a5b2afadc"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"8.14","label":"v8.14.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/181140","number":181140,"state":"MERGED","mergeCommit":{"sha":"f799e4fc253831332008fa7b06dc7c8d9c0d8c2a","message":"[8.14]
revert change to shared UX markdown component for dashboard vis
(#180906) (#181140)\n\n# Backport\n\nThis will backport the following
commits from `main` to `8.14`:\n- [revert change to shared UX markdown
component for dashboard
vis\n(#180906)](https://github.com/elastic/kibana/pull/180906)\n\n<!---
Backport version: 9.4.3 -->\n\n### Questions ?\nPlease refer to the
[Backport
tool\ndocumentation](https://github.com/sqren/backport)\n\n<!--BACKPORT
[{\"author\":{\"name\":\"Eyo
O.\nEyo\",\"email\":\"[email protected]\"},\"sourceCommit\":{\"committedDate\":\"2024-04-18T12:01:18Z\",\"message\":\"revert\nchange
to shared UX markdown component for dashboard vis
(#180906)\\n\\n##\nSummary\\r\\n\\r\\nThis PR reverts the change to the
shared UX markdown\ncomponent that\\r\\nhappened
here\nhttps://github.com//pull/176478.
The\\r\\naforementioned PR\nintroduced couple of visual issues that were
uncaught\\r\\nduring the\nmigration.\\r\\n\\r\\nThe known issues that
have been brought up that\ninformed the decision to\\r\\nrevert this
change, are itemised\nbelow;\\r\\n\\r\\n-
https://github.com/elastic/kibana/issues/180576\\r\\n-\nhttps://github.com/elastic/kibana/issues/180452\\r\\n-\nhttps://github.com/elastic/sdh-kibana/issues/4608\\r\\n\\r\\n\\r\\n###\nChecklist\\r\\n\\r\\n-
[x] [Unit
or\nfunctional\\r\\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\\r\\nwere\nupdated
or added to match the most common scenarios\\r\\n\\r\\n\\r\\n###
For\nmaintainers\\r\\n\\r\\n- [x] This was checked for breaking API
changes
and\nwas\n[labeled\\r\\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\\r\\n\\r\\n---------\\r\\n\\r\\nCo-authored-by:\nkibanamachine\n<[email protected]>\",\"sha\":\"4127163bd913dccfbd17badbb9ce1a7a5b2afadc\",\"branchLabelMapping\":{\"^v8.15.0$\":\"main\",\"^v(\\\\d+).(\\\\d+).\\\\d+$\":\"$1.$2\"}},\"sourcePullRequest\":{\"labels\":[\"release_note:fix\",\"Team:SharedUX\",\"backport:all-open\",\"v8.14.0\",\"v8.15.0\"],\"title\":\"revert\nchange
to shared UX markdown component for
dashboard\nvis\",\"number\":180906,\"url\":\"https://github.com/elastic/kibana/pull/180906\",\"mergeCommit\":{\"message\":\"revert\nchange
to shared UX markdown component for dashboard vis
(#180906)\\n\\n##\nSummary\\r\\n\\r\\nThis PR reverts the change to the
shared UX markdown\ncomponent that\\r\\nhappened
here\nhttps://github.com//pull/176478.
The\\r\\naforementioned PR\nintroduced couple of visual issues that were
uncaught\\r\\nduring the\nmigration.\\r\\n\\r\\nThe known issues that
have been brought up that\ninformed the decision to\\r\\nrevert this
change, are itemised\nbelow;\\r\\n\\r\\n-
https://github.com/elastic/kibana/issues/180576\\r\\n-\nhttps://github.com/elastic/kibana/issues/180452\\r\\n-\nhttps://github.com/elastic/sdh-kibana/issues/4608\\r\\n\\r\\n\\r\\n###\nChecklist\\r\\n\\r\\n-
[x] [Unit
or\nfunctional\\r\\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\\r\\nwere\nupdated
or added to match the most common scenarios\\r\\n\\r\\n\\r\\n###
For\nmaintainers\\r\\n\\r\\n- [x] This was checked for breaking API
changes
and\nwas\n[labeled\\r\\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\\r\\n\\r\\n---------\\r\\n\\r\\nCo-authored-by:\nkibanamachine\n<[email protected]>\",\"sha\":\"4127163bd913dccfbd17badbb9ce1a7a5b2afadc\"}},\"sourceBranch\":\"main\",\"suggestedTargetBranches\":[\"8.14\"],\"targetPullRequestStates\":[{\"branch\":\"8.14\",\"label\":\"v8.14.0\",\"branchLabelMappingKey\":\"^v(\\\\d+).(\\\\d+).\\\\d+$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"},{\"branch\":\"main\",\"label\":\"v8.15.0\",\"branchLabelMappingKey\":\"^v8.15.0$\",\"isSourceBranch\":true,\"state\":\"MERGED\",\"url\":\"https://github.com/elastic/kibana/pull/180906\",\"number\":180906,\"mergeCommit\":{\"message\":\"revert\nchange
to shared UX markdown component for dashboard vis
(#180906)\\n\\n##\nSummary\\r\\n\\r\\nThis PR reverts the change to the
shared UX markdown\ncomponent that\\r\\nhappened
here\nhttps://github.com//pull/176478.
The\\r\\naforementioned PR\nintroduced couple of visual issues that were
uncaught\\r\\nduring the\nmigration.\\r\\n\\r\\nThe known issues that
have been brought up that\ninformed the decision to\\r\\nrevert this
change, are itemised\nbelow;\\r\\n\\r\\n-
https://github.com/elastic/kibana/issues/180576\\r\\n-\nhttps://github.com/elastic/kibana/issues/180452\\r\\n-\nhttps://github.com/elastic/sdh-kibana/issues/4608\\r\\n\\r\\n\\r\\n###\nChecklist\\r\\n\\r\\n-
[x] [Unit
or\nfunctional\\r\\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\\r\\nwere\nupdated
or added to match the most common scenarios\\r\\n\\r\\n\\r\\n###
For\nmaintainers\\r\\n\\r\\n- [x] This was checked for breaking API
changes
and\nwas\n[labeled\\r\\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\\r\\n\\r\\n---------\\r\\n\\r\\nCo-authored-by:\nkibanamachine\n<[email protected]>\",\"sha\":\"4127163bd913dccfbd17badbb9ce1a7a5b2afadc\"}}]}]\nBACKPORT-->\n\nCo-authored-by:
Eyo O. Eyo
<[email protected]>"}},{"branch":"main","label":"v8.15.0","labelRegex":"^v8.15.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/180906","number":180906,"mergeCommit":{"message":"revert
change to shared UX markdown component for dashboard vis (#180906)\n\n##
Summary\r\n\r\nThis PR reverts the change to the shared UX markdown
component that\r\nhappened here
#176478. The\r\naforementioned PR
introduced couple of visual issues that were uncaught\r\nduring the
migration.\r\n\r\nThe known issues that have been brought up that
informed the decision to\r\nrevert this change, are itemised
below;\r\n\r\n- https://github.com/elastic/kibana/issues/180576\r\n-
https://github.com/elastic/kibana/issues/180452\r\n-
https://github.com/elastic/sdh-kibana/issues/4608\r\n\r\n\r\n###
Checklist\r\n\r\n- [x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n\r\n\r\n### For
maintainers\r\n\r\n- [x] This was checked for breaking API changes and
was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"4127163bd913dccfbd17badbb9ce1a7a5b2afadc"}}]}]
BACKPORT-->
sakurai-youhei added a commit that referenced this pull request May 13, 2024
## Summary

This PR adds an enableSoftLineBreaks parameter to the `<Markdown>`
component in shared-ux, which enables it to fill the gap in line
breaking between the legacy React `<Markdown>` component.


![enableSoftLineBreaks](https://github.com/elastic/kibana/assets/721858/f7b9b97a-e327-480b-aab9-f54419607669)

The parameter defaults to `false` not to change the current behavior in
existing use cases. Furthermore, there is currently no case where the
parameter is set to `true` because of
#180906.

Closes #180576

### Checklist

- [x] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)

### For maintainers

- [x] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:all-open Backport to all branches that could still receive a release release_note:fix Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience) v8.13.3 v8.14.0 v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants